<html>
<head><meta charset="utf-8"><title>Trouble generating internal compiler documentation · t-compiler/help · Zulip Chat Archive</title></head>
<h2>Stream: <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/index.html">t-compiler/help</a></h2>
<h3>Topic: <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html">Trouble generating internal compiler documentation</a></h3>

<hr>

<base href="https://rust-lang.zulipchat.com">

<head><link href="https://rust-lang.github.io/zulip_archive/style.css" rel="stylesheet"></head>

<a name="232640190"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232640190" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jake Vossen <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232640190">(Mar 31 2021 at 18:20)</a>:</h4>
<p>I am trying to build the documentation in <code>compiler/rustc_expand</code> by running <code>./x.py doc compiler/rustc_expand</code>, however I am getting this error: <code>skipping - compiler/librustdoc docs disabled</code></p>
<p>I am assuming it is something wrong with my config? Anyone have any ideas?</p>



<a name="232641243"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232641243" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232641243">(Mar 31 2021 at 18:26)</a>:</h4>
<p><span class="user-mention" data-user-id="246502">@jakevossen5</span> you need to set <code>compiler-docs = true</code> in config.toml</p>



<a name="232641274"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232641274" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232641274">(Mar 31 2021 at 18:27)</a>:</h4>
<p>are you interested in making a PR to bootstrap to suggest it? should be an easy fix :)</p>



<a name="232642110"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232642110" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jake Vossen <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232642110">(Mar 31 2021 at 18:32)</a>:</h4>
<p>Thanks!</p>
<p>So do you suggest if that <code>skipping - compiler/librustdoc docs disabled</code> we emit something like "try adding <code>compiler-docs = true</code>" ?</p>



<a name="232644034"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232644034" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232644034">(Mar 31 2021 at 18:45)</a>:</h4>
<p>yup I would recommend that :)</p>



<a name="232646605"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232646605" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jake Vossen <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232646605">(Mar 31 2021 at 19:02)</a>:</h4>
<p>Sure, I can take a look at that in a bit. Should I open an issue, or just a PR?</p>



<a name="232646797"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232646797" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232646797">(Mar 31 2021 at 19:03)</a>:</h4>
<p>just a PR is fine :)</p>



<a name="232647869"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232647869" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jake Vossen <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232647869">(Mar 31 2021 at 19:11)</a>:</h4>
<p>How does </p>
<p>skipping - compiler/librustdoc docs disabled. If you want to build internal compiler documentation, add <code>compiler-docs = true</code> to your <code>config.toml</code></p>
<p>Sound?</p>



<a name="232647924"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232647924" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jake Vossen <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232647924">(Mar 31 2021 at 19:11)</a>:</h4>
<p>I am trying to think of a more concise way to say it</p>



<a name="232648070"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232648070" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Joshua Nelson <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232648070">(Mar 31 2021 at 19:12)</a>:</h4>
<p>maybe "skipping - compiler/librustdoc docs disabled (use <code>compiler-docs = true</code> in config.toml to enable)"?</p>



<a name="232648162"></a>
<h4><a href="https://rust-lang.zulipchat.com#narrow/stream/182449-t-compiler/help/topic/Trouble%20generating%20internal%20compiler%20documentation/near/232648162" class="zl"><img src="https://rust-lang.github.io/zulip_archive/assets/img/zulip.svg" alt="view this post on Zulip" style="width:20px;height:20px;"></a> Jake Vossen <a href="https://rust-lang.github.io/zulip_archive/stream/182449-t-compiler/help/topic/Trouble.20generating.20internal.20compiler.20documentation.html#232648162">(Mar 31 2021 at 19:13)</a>:</h4>
<p>I like that</p>



<hr><p>Last updated: Aug 07 2021 at 22:04 UTC</p>
</html>